home *** CD-ROM | disk | FTP | other *** search
/ Aminet 51 / Aminet 51 (2002)(GTI - Schatztruhe)[!][Oct 2002].iso / Aminet / util / arc / xadmasterdev.lha / xad / Include / C / libraries / xadmaster.h
Encoding:
C/C++ Source or Header  |  2002-08-20  |  40.2 KB  |  898 lines
  1. #ifndef LIBRARIES_XADMASTER_H
  2. #define LIBRARIES_XADMASTER_H
  3.  
  4. /*
  5. **    $VER: xadmaster.h 12.0 (24.06.2002)
  6. **    xadmaster.library defines and structures
  7. **
  8. **    Copyright © 1998-2002 by Dirk Stöcker
  9. **    All Rights Reserved.
  10. */
  11.  
  12. #ifndef EXEC_LIBRARIES_H
  13. #include <exec/libraries.h>
  14. #endif
  15.  
  16. #ifndef UTILITY_TAGITEM_H
  17. #include <utility/tagitem.h>
  18. #endif
  19.  
  20. #define  XADNAME  "xadmaster.library"
  21.  
  22. /* NOTE: Nearly all structures need to be allocated using the
  23.    xadAllocObject function. */
  24.  
  25. /************************************************************************
  26. *                                    *
  27. *    library base structure                        *
  28. *                                    *
  29. ************************************************************************/
  30.  
  31. struct xadMasterBase {
  32.   struct Library       xmb_LibNode;
  33.   struct ExecBase *    xmb_SysBase;
  34.   struct DosLibrary *  xmb_DOSBase;
  35.   struct UtilityBase * xmb_UtilityBase;
  36.   ULONG            xmb_RecogSize;    /* read only */
  37.   STRPTR           xmb_DefaultName; /* name for XADFIF_NOFILENAME (V6) */
  38. };
  39.  
  40. /************************************************************************
  41. *                                    *
  42. *    tag-function call flags                        *
  43. *                                    *
  44. ************************************************************************/
  45.  
  46. /* input tags for xadGetInfo, only one can be specified per call */
  47. #define XAD_INSIZE        (TAG_USER+  1) /* input data size */
  48. #define XAD_INFILENAME        (TAG_USER+  2)
  49. #define XAD_INFILEHANDLE    (TAG_USER+  3)
  50. #define XAD_INMEMORY        (TAG_USER+  4)
  51. #define XAD_INHOOK        (TAG_USER+  5)
  52. #define XAD_INSPLITTED        (TAG_USER+  6) /* (V2) */
  53. #define XAD_INDISKARCHIVE    (TAG_USER+  7) /* (V4) */
  54. #define XAD_INXADSTREAM     (TAG_USER+  8) /* (V8) */
  55. #define XAD_INDEVICE        (TAG_USER+  9) /* (V11) */
  56.  
  57. /* output tags, only one can be specified per call, xadXXXXUnArc */
  58. #define XAD_OUTSIZE        (TAG_USER+ 10) /* output data size */
  59. #define XAD_OUTFILENAME     (TAG_USER+ 11)
  60. #define XAD_OUTFILEHANDLE    (TAG_USER+ 12)
  61. #define XAD_OUTMEMORY        (TAG_USER+ 13)
  62. #define XAD_OUTHOOK        (TAG_USER+ 14)
  63. #define XAD_OUTDEVICE        (TAG_USER+ 15)
  64. #define XAD_OUTXADSTREAM    (TAG_USER+ 16) /* (V8) */
  65.  
  66. /* object allocation tags for xadAllocObjectA */
  67. #define XAD_OBJNAMESIZE     (TAG_USER+ 20) /* XADOBJ_FILEINFO, size of needed name space */
  68. #define XAD_OBJCOMMENTSIZE    (TAG_USER+ 21) /* XADOBJ_FILEINFO, size of needed comment space */
  69. #define XAD_OBJPRIVINFOSIZE    (TAG_USER+ 22) /* XADOBJ_FILEINFO & XADOBJ_DISKINFO, self use size */
  70. #define XAD_OBJBLOCKENTRIES    (TAG_USER+ 23) /* XADOBJ_DISKINFO, number of needed entries */
  71.  
  72. /* tags for xadGetInfo, xadFileUnArc and xadDiskUnArc */
  73. #define XAD_NOEXTERN        (TAG_USER+ 50) /* do not use extern clients */
  74. #define XAD_PASSWORD        (TAG_USER+ 51) /* password when needed */
  75. #define XAD_ENTRYNUMBER     (TAG_USER+ 52) /* number of wanted entry */
  76. #define XAD_PROGRESSHOOK    (TAG_USER+ 53) /* the progress hook */
  77. #define XAD_OVERWRITE        (TAG_USER+ 54) /* overwrite file ? */
  78. #define XAD_MAKEDIRECTORY    (TAG_USER+ 55) /* create directory tree */
  79. #define XAD_IGNOREGEOMETRY    (TAG_USER+ 56) /* ignore drive geometry ? */
  80. #define XAD_LOWCYLINDER     (TAG_USER+ 57) /* lowest cylinder */
  81. #define XAD_HIGHCYLINDER    (TAG_USER+ 58) /* highest cylinder */
  82. #define XAD_VERIFY        (TAG_USER+ 59) /* verify for disk hook */
  83. #define XAD_NOKILLPARTIAL    (TAG_USER+ 60) /* do not delete partial/corrupt files (V3.3) */
  84. #define XAD_FORMAT        (TAG_USER+ 61) /* format output device (V5) */
  85. #define XAD_USESECTORLABELS    (TAG_USER+ 62) /* sector labels are stored on disk (V9) */
  86. #define XAD_IGNOREFLAGS     (TAG_USER+ 63) /* ignore the client, if certain flags are set (V11) */
  87. #define XAD_ONLYFLAGS        (TAG_USER+ 64) /* ignore the client, if certain flags are NOT set (V11) */
  88.  
  89. /* input tags for xadConvertDates, only one can be passed */
  90. #define XAD_DATEUNIX        (TAG_USER+ 70) /* unix date variable */
  91. #define XAD_DATEAMIGA        (TAG_USER+ 71) /* amiga date variable */
  92. #define XAD_DATEDATESTAMP    (TAG_USER+ 72) /* struct DateStamp */
  93. #define XAD_DATEXADDATE     (TAG_USER+ 73) /* struct xadDate */
  94. #define XAD_DATECLOCKDATA    (TAG_USER+ 74) /* struct ClockData */
  95. #define XAD_DATECURRENTTIME    (TAG_USER+ 75) /* input is system time */
  96. #define XAD_DATEMSDOS        (TAG_USER+ 76) /* MS-DOS packed format (V2) */
  97. #define XAD_DATEMAC        (TAG_USER+ 77) /* Mac date variable (V8) */
  98. #define XAD_DATECPM        (TAG_USER+ 78) /* CP/M data structure (V10) */
  99. #define XAD_DATECPM2        (TAG_USER+ 79) /* CP/M data structure type 2 (V10) */
  100. #define XAD_DATEISO9660     (TAG_USER+300) /* ISO9660 date structure (V11) */
  101.  
  102. /* output tags, there can be specified multiple tags for one call */
  103. #define XAD_GETDATEUNIX     (TAG_USER+ 80) /* unix date variable */
  104. #define XAD_GETDATEAMIGA    (TAG_USER+ 81) /* amiga date variable */
  105. #define XAD_GETDATEDATESTAMP    (TAG_USER+ 82) /* struct DateStamp */
  106. #define XAD_GETDATEXADDATE    (TAG_USER+ 83) /* struct xadDate */
  107. #define XAD_GETDATECLOCKDATA    (TAG_USER+ 84) /* struct ClockData */
  108. #define XAD_GETDATEMSDOS    (TAG_USER+ 86) /* MS-DOS packed format (V2) */
  109. #define XAD_GETDATEMAC        (TAG_USER+ 87) /* Mac date variable (V8) */
  110. #define XAD_GETDATECPM        (TAG_USER+ 88) /* CP/M data structure (V10) */
  111. #define XAD_GETDATECPM2     (TAG_USER+ 89) /* CP/M data structure type 2 (V10) */
  112. #define XAD_GETDATEISO9660    (TAG_USER+320) /* ISO9660 date structure (V11) */
  113.  
  114. /* following tags need locale.library to be installed */
  115. #define XAD_MAKEGMTDATE     (TAG_USER+ 90) /* make local to GMT time */
  116. #define XAD_MAKELOCALDATE    (TAG_USER+ 91) /* make GMT to local time */
  117.  
  118. /* tags for xadHookTagAccess (V3) */
  119. #define XAD_USESKIPINFO     (TAG_USER+104) /* the hook uses xadSkipInfo (V3) */
  120. #define XAD_SECTORLABELS    (TAG_USER+105) /* pass sector labels with XADAC_WRITE (V9) */
  121.  
  122. #define XAD_GETCRC16        (TAG_USER+120) /* pointer to UWORD value (V3) */
  123. #define XAD_GETCRC32        (TAG_USER+121) /* pointer to ULONG value (V3) */
  124.  
  125. #define XAD_CRC16ID        (TAG_USER+130) /* ID for crc calculation (V3) */
  126. #define XAD_CRC32ID        (TAG_USER+131) /* ID for crc calculation (V3) */
  127.  
  128. /* tags for xadConvertProtection (V4) */
  129. #define XAD_PROTAMIGA        (TAG_USER+160) /* Amiga type protection bits (V4) */
  130. #define XAD_PROTUNIX        (TAG_USER+161) /* protection bits in UNIX mode (V4) */
  131. #define XAD_PROTMSDOS        (TAG_USER+162) /* MSDOS type protection bits (V4) */
  132. #define XAD_PROTFILEINFO    (TAG_USER+163) /* input is a xadFileInfo structure (V11) */
  133.  
  134. #define XAD_GETPROTAMIGA    (TAG_USER+170) /* return Amiga protection bits (V4) */
  135. #define XAD_GETPROTUNIX     (TAG_USER+171) /* return UNIX protection bits (V11) */
  136. #define XAD_GETPROTMSDOS    (TAG_USER+172) /* return MSDOS protection bits (V11) */
  137. #define XAD_GETPROTFILEINFO    (TAG_USER+173) /* fill xadFileInfo protection fields (V11) */
  138.  
  139. /* tags for xadGetDiskInfo (V7) */
  140. #define XAD_STARTCLIENT     (TAG_USER+180) /* the client to start with (V7) */
  141. #define XAD_NOEMPTYERROR    (TAG_USER+181) /* do not create XADERR_EMPTY (V8) */
  142.  
  143. /* tags for xadFreeHookAccess (V8) */
  144. #define XAD_WASERROR        (TAG_USER+190) /* error occured, call abort method (V8) */
  145.  
  146. /* tags for miscellaneous stuff */
  147. #define XAD_ARCHIVEINFO     (TAG_USER+200) /* xadArchiveInfo for stream hooks (V8) */
  148. #define XAD_ERRORCODE        (TAG_USER+201) /* error code of function (V12) */
  149.  
  150. /* tags for xadAddFileEntry and xadAddDiskEntry (V10) */
  151. #define XAD_SETINPOS        (TAG_USER+240) /* set xai_InPos after call (V10) */
  152. #define XAD_INSERTDIRSFIRST    (TAG_USER+241) /* insert dirs at list start (V10) */
  153.  
  154. /* tags for xadConvertName (V12) */
  155. #define XAD_PATHSEPERATOR    (TAG_USER+260) /* UWORD *, default is {'/','\\',0} in source charset (V12) */
  156. #define XAD_CHARACTERSET    (TAG_USER+261) /* the characterset of string (V12) */
  157. #define XAD_STRINGSIZE        (TAG_USER+262) /* maximum size of following (V12) */
  158. #define XAD_CSTRING        (TAG_USER+263) /* zero-terminated string (V12) */
  159. #define XAD_PSTRING        (TAG_USER+264) /* lengthed Pascal string (V12) */
  160. #define XAD_XADSTRING        (TAG_USER+265) /* an xad string (V12) */
  161. #define XAD_ADDPATHSEPERATOR    (TAG_USER+266) /* default is TRUE (V12) */
  162.  
  163. /* tags for xadGetFilename (V12) */
  164. #define XAD_NOLEADINGPATH    (TAG_USER+280) /* default is FALSE (V12) */
  165. #define XAD_NOTRAILINGPATH    (TAG_USER+281) /* default is FALSE (V12) */
  166. #define XAD_MASKCHARACTERS    (TAG_USER+282) /* default are #?()[]~%*:|",1-31,127-160 (V12) */
  167. #define XAD_MASKINGCHAR     (TAG_USER+283) /* default is '_' (V12) */
  168. #define XAD_REQUIREDBUFFERSIZE    (TAG_USER+284) /* pointer which should hold buf size (V12) */
  169.  
  170.  
  171. /* Places 300-339 used for dates! */
  172.  
  173. /************************************************************************
  174. *                                    *
  175. *    objects for xadAllocObjectA                    *
  176. *                                    *
  177. ************************************************************************/
  178.  
  179. #define XADOBJ_ARCHIVEINFO    0x0001 /* struct xadArchiveInfo */
  180. #define XADOBJ_FILEINFO     0x0002 /* struct xadFileInfo */
  181. #define XADOBJ_DISKINFO     0x0003 /* struct xadDiskInfo */
  182. #define XADOBJ_HOOKPARAM    0x0004 /* struct HookParam */
  183. #define XADOBJ_DEVICEINFO    0x0005 /* struct xadDeviceInfo */
  184. #define XADOBJ_PROGRESSINFO    0x0006 /* struct xadProgressInfo */
  185. #define XADOBJ_TEXTINFO     0x0007 /* struct xadTextInfo */
  186. #define XADOBJ_SPLITFILE    0x0008 /* struct xadSplitFile (V2) */
  187. #define XADOBJ_SKIPINFO     0x0009 /* struct xadSkipInfo (V3) */
  188. #define XADOBJ_IMAGEINFO    0x000A /* struct xadImageInfo (V4) */
  189. #define XADOBJ_SPECIAL        0x000B /* struct xadSpecial (V11) */
  190.  
  191. /* result type of xadAllocVec */
  192. #define XADOBJ_MEMBLOCK     0x0100 /* memory of requested size and type */
  193. /* private type */
  194. #define XADOBJ_STRING        0x0101 /* an typed XAD string (V12) */
  195.  
  196. /************************************************************************
  197. *                                    *
  198. *    modes for xadCalcCRC126 and xadCalcCRC32                *
  199. *                                    *
  200. ************************************************************************/
  201.  
  202. #define XADCRC16_ID1        0xA001
  203. #define XADCRC32_ID1        0xEDB88320
  204.  
  205. /************************************************************************
  206. *                                    *
  207. *    hook related stuff                         *
  208. *                                    *
  209. ************************************************************************/
  210.  
  211. #define XADHC_READ    1    /* read data into buffer */
  212. #define XADHC_WRITE    2    /* write buffer data to file/memory */
  213. #define XADHC_SEEK    3    /* seek in file */
  214. #define XADHC_INIT    4    /* initialize the hook */
  215. #define XADHC_FREE    5    /* end up hook work, free stuff */
  216. #define XADHC_ABORT    6    /* an error occured, delete partial stuff */
  217. #define XADHC_FULLSIZE    7    /* complete input size is needed */
  218. #define XADHC_IMAGEINFO 8    /* return disk image info (V4) */
  219.  
  220. struct xadHookParam {
  221.   ULONG xhp_Command;
  222.   LONG    xhp_CommandData;
  223.   APTR    xhp_BufferPtr;
  224.   ULONG xhp_BufferSize;
  225.   ULONG xhp_DataPos;        /* current seek position */
  226.   APTR    xhp_PrivatePtr;
  227.   APTR    xhp_TagList;        /* allows to transport tags to hook (V9) */
  228. };
  229.  
  230. /* xadHookAccess commands */
  231. #define XADAC_READ        10    /* get data */
  232. #define XADAC_WRITE        11    /* write data */
  233. #define XADAC_COPY        12    /* copy input to output */
  234. #define XADAC_INPUTSEEK     13    /* seek in input file */
  235. #define XADAC_OUTPUTSEEK    14    /* seek in output file */
  236.  
  237. /************************************************************************
  238. *                                    *
  239. *    support structures                         *
  240. *                                    *
  241. ************************************************************************/
  242.  
  243. /* Own date structure to cover all possible dates in a human friendly
  244.    format. xadConvertDates may be used to convert between different date
  245.    structures and variables. */
  246. struct xadDate {
  247.   ULONG xd_Micros;    /* values 0 to 999999      */
  248.   LONG    xd_Year;    /* values 1 to 2147483648 */
  249.   UBYTE xd_Month;    /* values 1 to 12      */
  250.   UBYTE xd_WeekDay;    /* values 1 to 7      */
  251.   UBYTE xd_Day;     /* values 1 to 31      */
  252.   UBYTE xd_Hour;    /* values 0 to 23      */
  253.   UBYTE xd_Minute;    /* values 0 to 59      */
  254.   UBYTE xd_Second;    /* values 0 to 59      */
  255. };
  256.  
  257. #define XADDAY_MONDAY        1    /* monday is the first day and */
  258. #define XADDAY_TUESDAY        2
  259. #define XADDAY_WEDNESDAY    3
  260. #define XADDAY_THURSDAY     4
  261. #define XADDAY_FRIDAY        5
  262. #define XADDAY_SATURDAY     6
  263. #define XADDAY_SUNDAY        7    /* sunday the last day of a week */
  264.  
  265. struct xadDeviceInfo { /* for XAD_OUTDEVICE tag */
  266.   STRPTR xdi_DeviceName; /* name of device */
  267.   ULONG  xdi_Unit;     /* unit of device */
  268.   STRPTR xdi_DOSName;     /* instead of Device+Unit, dos name without ':' */
  269. };
  270.  
  271. struct xadSplitFile { /* for XAD_INSPLITTED */
  272.   struct xadSplitFile *xsf_Next;
  273.   ULONG            xsf_Type; /* XAD_INFILENAME, XAD_INFILEHANDLE, XAD_INMEMORY, XAD_INHOOK */
  274.   ULONG            xsf_Size; /* necessary for XAD_INMEMORY, useful for others */
  275.   ULONG            xsf_Data; /* FileName, Filehandle, Hookpointer or Memory */
  276. };
  277.  
  278. struct xadSkipInfo {
  279.   struct xadSkipInfo *xsi_Next;
  280.   ULONG           xsi_Position; /* position, where it should be skipped */
  281.   ULONG           xsi_SkipSize; /* size to skip */
  282. };
  283.  
  284. struct xadImageInfo { /* for XADHC_IMAGEINFO */
  285.   ULONG xii_SectorSize;   /* usually 512 */
  286.   ULONG xii_FirstSector;  /* of the image file */
  287.   ULONG xii_NumSectors;   /* of the image file */
  288.   ULONG xii_TotalSectors; /* of this device type */
  289. };
  290. /* If the image file holds total data of disk xii_TotalSectors equals
  291.    xii_NumSectors and xii_FirstSector is zero. Addition of xii_FirstSector
  292.    and xii_NumSectors cannot exceed xii_TotalSectors value!
  293. */
  294.  
  295. /************************************************************************
  296. *                                    *
  297. *    information structures                        *
  298. *                                    *
  299. ************************************************************************/
  300.  
  301. struct xadArchiveInfo {
  302.   struct xadClient *   xai_Client;   /* pointer to unarchiving client */
  303.   APTR               xai_PrivateClient; /* private client data */
  304.   STRPTR           xai_Password; /* password for crypted archives */
  305.   ULONG            xai_Flags;    /* read only XADAIF_ flags */
  306.   ULONG            xai_LowCyl;   /* lowest cylinder to unarchive */
  307.   ULONG            xai_HighCyl;  /* highest cylinder to unarchive */
  308.   ULONG            xai_InPos;    /* input position, read only */
  309.   ULONG            xai_InSize;   /* input size, read only */
  310.   ULONG            xai_OutPos;   /* output position, read only */
  311.   ULONG            xai_OutSize;  /* output file size, read only */
  312.   struct xadFileInfo * xai_FileInfo; /* data pointer for file arcs */
  313.   struct xadDiskInfo * xai_DiskInfo; /* data pointer for disk arcs */
  314.   struct xadFileInfo * xai_CurFile;  /* data pointer for current file arc */
  315.   struct xadDiskInfo * xai_CurDisk;  /* data pointer for current disk arc */
  316.   LONG               xai_LastError;    /* last error, when XADAIF_FILECORRUPT (V2) */
  317.   ULONG *           xai_MultiVolume; /* array of start offsets from parts (V2) */
  318.   struct xadSkipInfo * xai_SkipInfo;    /* linked list of skip entries (V3) */
  319.   struct xadImageInfo *xai_ImageInfo;    /* for filesystem clients (V5) */
  320.   STRPTR           xai_InName;   /* Input archive name if available (V7) */
  321. };
  322. /* This structure is nearly complete private to either xadmaster or its
  323. clients. An application program may access for reading only xai_Client,
  324. xai_Flags, xai_FileInfo and xai_DiskInfo. For xai_Flags only XADAIF_CRYPTED
  325. and XADAIF_FILECORRUPT are useful. All the other stuff is private and should
  326. not be accessed! */
  327.  
  328. #define XADAIB_CRYPTED         0 /* archive entries are encrypted */
  329. #define XADAIB_FILECORRUPT     1 /* file is corrupt, but valid entries are in the list */
  330. #define XADAIB_FILEARCHIVE     2 /* unarchive file entry */
  331. #define XADAIB_DISKARCHIVE     3 /* unarchive disk entry */
  332. #define XADAIB_OVERWRITE     4 /* overwrite the file (PRIVATE) */
  333. #define XADAIB_MAKEDIRECTORY     5 /* create directory when missing (PRIVATE) */
  334. #define XADAIB_IGNOREGEOMETRY     6 /* ignore drive geometry (PRIVATE) */
  335. #define XADAIB_VERIFY         7 /* verify is turned on for disk hook (PRIVATE) */
  336. #define XADAIB_NOKILLPARTIAL     8 /* do not delete partial files (PRIVATE) */
  337. #define XADAIB_DISKIMAGE     9 /* is disk image extraction (V5) */
  338. #define XADAIB_FORMAT        10 /* format in disk hook (PRIVATE) */
  339. #define XADAIB_NOEMPTYERROR    11 /* do not create empty error (PRIVATE) */
  340. #define XADAIB_ONLYIN        12 /* in stuff only (PRIVATE) */
  341. #define XADAIB_ONLYOUT        13 /* out stuff only (PRIVATE) */
  342. #define XADAIB_USESECTORLABELS    14 /* use SectorLabels (PRIVATE) */
  343.  
  344. #define XADAIF_CRYPTED        (1<<XADAIB_CRYPTED)
  345. #define XADAIF_FILECORRUPT    (1<<XADAIB_FILECORRUPT)
  346. #define XADAIF_FILEARCHIVE    (1<<XADAIB_FILEARCHIVE)
  347. #define XADAIF_DISKARCHIVE    (1<<XADAIB_DISKARCHIVE)
  348. #define XADAIF_OVERWRITE    (1<<XADAIB_OVERWRITE)
  349. #define XADAIF_MAKEDIRECTORY    (1<<XADAIB_MAKEDIRECTORY)
  350. #define XADAIF_IGNOREGEOMETRY    (1<<XADAIB_IGNOREGEOMETRY)
  351. #define XADAIF_VERIFY        (1<<XADAIB_VERIFY)
  352. #define XADAIF_NOKILLPARTIAL    (1<<XADAIB_NOKILLPARTIAL)
  353. #define XADAIF_DISKIMAGE    (1<<XADAIB_DISKIMAGE)
  354. #define XADAIF_FORMAT        (1<<XADAIB_FORMAT)
  355. #define XADAIF_NOEMPTYERROR    (1<<XADAIB_NOEMPTYERROR)
  356. #define XADAIF_ONLYIN        (1<<XADAIB_ONLYIN)
  357. #define XADAIF_ONLYOUT        (1<<XADAIB_ONLYOUT)
  358. #define XADAIF_USESECTORLABELS    (1<<XADAIB_USESECTORLABELS)
  359.  
  360. struct xadFileInfo {
  361.   struct xadFileInfo * xfi_Next;
  362.   ULONG            xfi_EntryNumber;/* number of entry */
  363.   STRPTR           xfi_EntryInfo;  /* additional archiver text */
  364.   APTR               xfi_PrivateInfo;/* client private, see XAD_OBJPRIVINFOSIZE */
  365.   ULONG            xfi_Flags;      /* see XADFIF_xxx defines */
  366.   STRPTR           xfi_FileName;   /* see XAD_OBJNAMESIZE tag */
  367.   STRPTR           xfi_Comment;    /* see XAD_OBJCOMMENTSIZE tag */
  368.   ULONG            xfi_Protection; /* OS 3 bits (including multiuser) */
  369.   ULONG            xfi_OwnerUID;   /* user ID */
  370.   ULONG            xfi_OwnerGID;   /* group ID */
  371.   STRPTR           xfi_UserName;   /* user name */
  372.   STRPTR           xfi_GroupName;  /* group name */
  373.   ULONG            xfi_Size;       /* size of this file */
  374.   ULONG            xfi_GroupCrSize;/* crunched size of group */
  375.   ULONG            xfi_CrunchSize; /* crunched size */
  376.   STRPTR           xfi_LinkName;   /* name and path of link */
  377.   struct xadDate       xfi_Date;
  378.   UWORD            xfi_Generation; /* File Generation [0...0xFFFF] (V3) */
  379.   ULONG            xfi_DataPos;    /* crunched data position (V3) */
  380.   struct xadFileInfo * xfi_MacFork;    /* pointer to 2nd fork for Mac (V7) */
  381.   UWORD            xfi_UnixProtect;/* protection bits for Unix (V11) */
  382.   UBYTE            xfi_DosProtect; /* protection bits for MS-DOS (V11) */
  383.   UBYTE            xfi_FileType;   /* XADFILETYPE to define type of exe files (V11) */
  384.   struct xadSpecial *  xfi_Special;    /* pointer to special data (V11) */
  385. };
  386.  
  387. /* These are used for xfi_FileType to define file type. (V11) */
  388. #define XADFILETYPE_DATACRUNCHER     1     /* infile was only one data file */
  389. #define XADFILETYPE_TEXTLINKER         2     /* infile was text-linked */
  390.  
  391. #define XADFILETYPE_AMIGAEXECRUNCHER 11  /* infile was an Amiga exe cruncher */
  392. #define XADFILETYPE_AMIGAEXELINKER   12  /* infile was an Amiga exe linker */
  393. #define XADFILETYPE_AMIGATEXTLINKER  13  /* infile was an Amiga text-exe linker */
  394. #define XADFILETYPE_AMIGAADDRESS     14  /* infile was an Amiga address cruncher */
  395.  
  396. #define XADFILETYPE_UNIXBLOCKDEVICE  21  /* this file is a block device */
  397. #define XADFILETYPE_UNIXCHARDEVICE   22  /* this file is a character device */
  398. #define XADFILETYPE_UNIXFIFO         23  /* this file is a named pipe */
  399. #define XADFILETYPE_UNIXSOCKET         24  /* this file is a socket */
  400.  
  401. #define XADFILETYPE_MSDOSEXECRUNCHER 31  /* infile was an MSDOS exe cruncher */
  402.  
  403. #define XADSPECIALTYPE_UNIXDEVICE    1 /* xadSpecial entry is xadSpecialUnixDevice */
  404. #define XADSPECIALTYPE_AMIGAADDRESS  2 /* xadSpecial entry is xadSpecialAmigaAddress */
  405. #define XADSPECIALTYPE_CBM8BIT         3 /* xadSpecial entry is xadSpecialCBM8bit */
  406.  
  407. struct xadSpecialUnixDevice
  408. {
  409.   ULONG xfis_MajorVersion;    /* major device version */
  410.   ULONG xfis_MinorVersion;    /* minor device version */
  411. };
  412.  
  413. struct xadSpecialAmigaAddress
  414. {
  415.   ULONG xfis_JumpAddress;     /* code executaion start address */
  416.   ULONG xfis_DecrunchAddress; /* decrunch start of code */
  417. };
  418.  
  419. struct xadSpecialCBM8bit
  420. {
  421.   UBYTE xfis_FileType;          /* File type XADCBM8BITTYPE_xxx */
  422.   UBYTE xfis_RecordLength;    /* record length if relative file */
  423. };
  424. #define XADCBM8BITTYPE_UNKNOWN    0x00    /*      Unknown / Unused */
  425. #define XADCBM8BITTYPE_BASIC    0x01    /* Tape - BASIC program file */
  426. #define XADCBM8BITTYPE_DATA    0x02    /* Tape - Data block (SEQ file) */
  427. #define XADCBM8BITTYPE_FIXED    0x03    /* Tape - Fixed addres program file */
  428. #define XADCBM8BITTYPE_SEQDATA    0x04    /* Tape - Sequential data file */
  429. #define XADCBM8BITTYPE_SEQ    0x81    /* Disk - Sequential file "SEQ" */
  430. #define XADCBM8BITTYPE_PRG    0x82    /* Disk - Program file "PRG" */
  431. #define XADCBM8BITTYPE_USR    0x83    /* Disk - User-defined file "USR" */
  432. #define XADCBM8BITTYPE_REL    0x84    /* Disk - Relative records file "REL" */
  433. #define XADCBM8BITTYPE_CBM    0x85    /* Disk - CBM (partition) "CBM" */
  434.  
  435. struct xadSpecial
  436. {
  437.   ULONG          xfis_Type; /* XADSPECIALTYPE to define type of block (V11) */
  438.   struct xadSpecial *xfis_Next; /* pointer to next entry */
  439.   union
  440.   {
  441.     struct xadSpecialUnixDevice   xfis_UnixDevice;
  442.     struct xadSpecialAmigaAddress xfis_AmigaAddress;
  443.     struct xadSpecialCBM8bit      xfis_CBM8bit;
  444.   } xfis_Data;
  445. };
  446.  
  447. /* Multiuser fields (xfi_OwnerUID, xfi_OwnerUID, xfi_UserName, xfi_GroupName)
  448.    and multiuser bits (see <dos/dos.h>) are currently not supported with normal
  449.    Amiga filesystem. But the clients support them, if archive format holds
  450.    such information.
  451.  
  452.    The protection bits (all 3 fields) should always be set using the
  453.    xadConvertProtection procedure. Call it with as much protection information
  454.    as possible. It extracts the relevant data at best (and also sets the 2 flags).
  455.    DO NOT USE these fields directly, but always through xadConvertProtection
  456.    call.
  457. */
  458.  
  459. #define XADFIB_CRYPTED        0 /* entry is crypted */
  460. #define XADFIB_DIRECTORY    1 /* entry is a directory */
  461. #define XADFIB_LINK        2 /* entry is a link */
  462. #define XADFIB_INFOTEXT     3 /* file is an information text */
  463. #define XADFIB_GROUPED        4 /* file is in a crunch group */
  464. #define XADFIB_ENDOFGROUP    5 /* crunch group ends here */
  465. #define XADFIB_NODATE        6 /* no date supported, CURRENT date is set */
  466. #define XADFIB_DELETED        7 /* file is marked as deleted (V3) */
  467. #define XADFIB_SEEKDATAPOS    8 /* before unarchiving the datapos is set (V3) */
  468. #define XADFIB_NOFILENAME    9 /* there was no filename, using internal one (V6) */
  469. #define XADFIB_NOUNCRUNCHSIZE  10 /* file size is unknown and thus set to zero (V6) */
  470. #define XADFIB_PARTIALFILE     11 /* file is only partial (V6) */
  471. #define XADFIB_MACDATA           12 /* file is Apple data fork (V7) */
  472. #define XADFIB_MACRESOURCE     13 /* file is Apple resource fork (V7) */
  473. #define XADFIB_EXTRACTONBUILD  14 /* allows extract file during scanning (V10) */
  474. #define XADFIB_UNIXPROTECTION  15 /* UNIX protection bits are present (V11) */
  475. #define XADFIB_DOSPROTECTION   16 /* MSDOS protection bits are present (V11) */
  476. #define XADFIB_ENTRYMAYCHANGE  17 /* this entry may change until GetInfo is finished (V11) */
  477. #define XADFIB_XADSTRFILENAME  18 /* the xfi_FileName fields is an XAD string (V12) */
  478. #define XADFIB_XADSTRLINKNAME  19 /* the xfi_LinkName fields is an XAD string (V12) */
  479. #define XADFIB_XADSTRCOMMENT   20 /* the xfi_Comment fields is an XAD string (V12) */
  480.  
  481. #define XADFIF_CRYPTED        (1<<XADFIB_CRYPTED)
  482. #define XADFIF_DIRECTORY    (1<<XADFIB_DIRECTORY)
  483. #define XADFIF_LINK        (1<<XADFIB_LINK)
  484. #define XADFIF_INFOTEXT     (1<<XADFIB_INFOTEXT)
  485. #define XADFIF_GROUPED        (1<<XADFIB_GROUPED)
  486. #define XADFIF_ENDOFGROUP    (1<<XADFIB_ENDOFGROUP)
  487. #define XADFIF_NODATE        (1<<XADFIB_NODATE)
  488. #define XADFIF_DELETED        (1<<XADFIB_DELETED)
  489. #define XADFIF_SEEKDATAPOS    (1<<XADFIB_SEEKDATAPOS)
  490. #define XADFIF_NOFILENAME    (1<<XADFIB_NOFILENAME)
  491. #define XADFIF_NOUNCRUNCHSIZE    (1<<XADFIB_NOUNCRUNCHSIZE)
  492. #define XADFIF_PARTIALFILE    (1<<XADFIB_PARTIALFILE)
  493. #define XADFIF_MACDATA        (1<<XADFIB_MACDATA)
  494. #define XADFIF_MACRESOURCE    (1<<XADFIB_MACRESOURCE)
  495. #define XADFIF_EXTRACTONBUILD    (1<<XADFIB_EXTRACTONBUILD)
  496. #define XADFIF_UNIXPROTECTION    (1<<XADFIB_UNIXPROTECTION)
  497. #define XADFIF_DOSPROTECTION    (1<<XADFIB_DOSPROTECTION)
  498. #define XADFIF_ENTRYMAYCHANGE    (1<<XADFIB_ENTRYMAYCHANGE)
  499. #define XADFIF_XADSTRFILENAME    (1<<XADFIB_XADSTRFILENAME)
  500. #define XADFIF_XADSTRLINKNAME    (1<<XADFIB_XADSTRLINKNAME)
  501. #define XADFIF_XADSTRCOMMENT    (1<<XADFIB_XADSTRCOMMENT)
  502.  
  503. /* NOTE: the texts passed with that structure must not always be printable.
  504.    Although the clients should add an additional (not counted) zero at the text
  505.    end, the whole file may contain other unprintable stuff (e.g. for DMS).
  506.    So when printing this texts do it on a byte for byte base including
  507.    printability checks.
  508. */
  509. struct xadTextInfo {
  510.   struct xadTextInfo *    xti_Next;
  511.   ULONG         xti_Size;  /* maybe zero - no text - e.g. when crypted */
  512.   STRPTR        xti_Text;  /* and there is no password in xadGetInfo() */
  513.   ULONG         xti_Flags; /* see XADTIF_xxx defines */
  514. };
  515.  
  516. #define XADTIB_CRYPTED        0 /* entry is empty, as data was crypted */
  517. #define XADTIB_BANNER        1 /* text is a banner */
  518. #define XADTIB_FILEDIZ        2 /* text is a file description */
  519.  
  520. #define XADTIF_CRYPTED        (1<<XADTIB_CRYPTED)
  521. #define XADTIF_BANNER        (1<<XADTIB_BANNER)
  522. #define XADTIF_FILEDIZ        (1<<XADTIB_FILEDIZ)
  523.  
  524. struct xadDiskInfo {
  525.   struct xadDiskInfo *    xdi_Next;
  526.   ULONG         xdi_EntryNumber;  /* number of entry */
  527.   STRPTR        xdi_EntryInfo;      /* additional archiver text */
  528.   APTR            xdi_PrivateInfo;  /* client private, see XAD_OBJPRIVINFOSIZE */
  529.   ULONG         xdi_Flags;      /* see XADDIF_xxx defines */
  530.   ULONG         xdi_SectorSize;
  531.   ULONG         xdi_TotalSectors; /* see devices/trackdisk.h */
  532.   ULONG         xdi_Cylinders;      /* to find out what these */
  533.   ULONG         xdi_CylSectors;   /* fields mean, they are equal */
  534.   ULONG         xdi_Heads;      /* to struct DriveGeometry */
  535.   ULONG         xdi_TrackSectors;
  536.   ULONG         xdi_LowCyl;      /* lowest cylinder stored */
  537.   ULONG         xdi_HighCyl;      /* highest cylinder stored */
  538.   ULONG         xdi_BlockInfoSize;/* number of BlockInfo entries */
  539.   UBYTE *        xdi_BlockInfo;      /* see XADBIF_xxx defines and XAD_OBJBLOCKENTRIES tag */
  540.   struct xadTextInfo *    xdi_TextInfo;      /* linked list with info texts */
  541.   ULONG         xdi_DataPos;      /* crunched data position (V3) */
  542. };
  543.  
  544. /* BlockInfo points to a UBYTE field for every track from first sector of
  545.    lowest cylinder to last sector of highest cylinder. When not used,
  546.    pointer must be 0. Do not use it, when there are no entries!
  547.    This is just for information. The applications still asks the client
  548.    to unarchive whole cylinders and not archived blocks are cleared for
  549.    unarchiving.
  550. */
  551.  
  552. #define XADDIB_CRYPTED          0 /* entry is crypted */
  553. #define XADDIB_SEEKDATAPOS      1 /* before unarchiving the datapos is set (V3) */
  554. #define XADDIB_SECTORLABELS      2 /* the clients delivers sector labels (V9) */
  555. #define XADDIB_EXTRACTONBUILD      3 /* allows extract disk during scanning (V10) */
  556. #define XADDIB_ENTRYMAYCHANGE      4 /* this entry may change until GetInfo is finished (V11) */
  557.  
  558. /* Some of the crunchers do not store all necessary information, so it
  559. may be needed to guess some of them. Set the following flags in that case
  560. and geometry check will ignore these fields. */
  561. #define XADDIB_GUESSSECTORSIZE      5 /* sectorsize is guessed (V10) */
  562. #define XADDIB_GUESSTOTALSECTORS  6 /* totalsectors number is guessed (V10) */
  563. #define XADDIB_GUESSCYLINDERS      7 /* cylinder number is guessed */
  564. #define XADDIB_GUESSCYLSECTORS      8 /* cylsectors is guessed */
  565. #define XADDIB_GUESSHEADS      9 /* number of heads is guessed */
  566. #define XADDIB_GUESSTRACKSECTORS 10 /* tracksectors is guessed */
  567. #define XADDIB_GUESSLOWCYL     11 /* lowcyl is guessed */
  568. #define XADDIB_GUESSHIGHCYL     12 /* highcyl is guessed */
  569.  
  570. /* If it is impossible to set some of the fields, you need to set some of
  571. these flags. NOTE: XADDIB_NOCYLINDERS is really important, as this turns
  572. of usage of lowcyl and highcyl keywords. When you have cylinder information,
  573. you should not use these and instead use guess flags and calculate
  574. possible values for the missing fields. */
  575. #define XADDIB_NOCYLINDERS     15 /* cylinder number is not set */
  576. #define XADDIB_NOCYLSECTORS     16 /* cylsectors is not set */
  577. #define XADDIB_NOHEADS         17 /* number of heads is not set */
  578. #define XADDIB_NOTRACKSECTORS     18 /* tracksectors is not set */
  579. #define XADDIB_NOLOWCYL      19 /* lowcyl is not set */
  580. #define XADDIB_NOHIGHCYL     20 /* highcyl is not set */
  581.  
  582. #define XADDIF_CRYPTED         (1<<XADDIB_CRYPTED)
  583. #define XADDIF_SEEKDATAPOS     (1<<XADDIB_SEEKDATAPOS)
  584. #define XADDIF_SECTORLABELS     (1<<XADDIB_SECTORLABELS)
  585. #define XADDIF_EXTRACTONBUILD     (1<<XADDIB_EXTRACTONBUILD)
  586. #define XADDIF_ENTRYMAYCHANGE     (1<<XADDIB_ENTRYMAYCHANGE)
  587.  
  588. #define XADDIF_GUESSSECTORSIZE     (1<<XADDIB_GUESSSECTORSIZE)
  589. #define XADDIF_GUESSTOTALSECTORS (1<<XADDIB_GUESSTOTALSECTORS)
  590. #define XADDIF_GUESSCYLINDERS     (1<<XADDIB_GUESSCYLINDERS)
  591. #define XADDIF_GUESSCYLSECTORS     (1<<XADDIB_GUESSCYLSECTORS)
  592. #define XADDIF_GUESSHEADS     (1<<XADDIB_GUESSHEADS)
  593. #define XADDIF_GUESSTRACKSECTORS (1<<XADDIB_GUESSTRACKSECTORS)
  594. #define XADDIF_GUESSLOWCYL     (1<<XADDIB_GUESSLOWCYL)
  595. #define XADDIF_GUESSHIGHCYL     (1<<XADDIB_GUESSHIGHCYL)
  596.  
  597. #define XADDIF_NOCYLINDERS     (1<<XADDIB_NOCYLINDERS)
  598. #define XADDIF_NOCYLSECTORS     (1<<XADDIB_NOCYLSECTORS)
  599. #define XADDIF_NOHEADS         (1<<XADDIB_NOHEADS)
  600. #define XADDIF_NOTRACKSECTORS     (1<<XADDIB_NOTRACKSECTORS)
  601. #define XADDIF_NOLOWCYL      (1<<XADDIB_NOLOWCYL)
  602. #define XADDIF_NOHIGHCYL     (1<<XADDIB_NOHIGHCYL)
  603.  
  604. /* defines for BlockInfo */
  605. #define XADBIB_CLEARED        0 /* this block was cleared for archiving */
  606. #define XADBIB_UNUSED        1 /* this block was not archived */
  607.  
  608. #define XADBIF_CLEARED        (1<<XADBIB_CLEARED)
  609. #define XADBIF_UNUSED        (1<<XADBIB_UNUSED)
  610.  
  611. /************************************************************************
  612. *                                    *
  613. *    progress report stuff                        *
  614. *                                    *
  615. ************************************************************************/
  616.  
  617. struct xadProgressInfo {
  618.   ULONG         xpi_Mode;    /* work modus */
  619.   struct xadClient *    xpi_Client;    /* the client doing the work */
  620.   struct xadDiskInfo *    xpi_DiskInfo;    /* current diskinfo, for disks */
  621.   struct xadFileInfo *    xpi_FileInfo;    /* current info for files */
  622.   ULONG         xpi_CurrentSize;/* current filesize */
  623.   ULONG         xpi_LowCyl;    /* for disks only */
  624.   ULONG         xpi_HighCyl;    /* for disks only */
  625.   ULONG         xpi_Status;    /* see XADPIF flags */
  626.   LONG            xpi_Error;    /* any of the error codes */
  627.   STRPTR        xpi_FileName;    /* name of file to overwrite (V2) */
  628.   STRPTR        xpi_NewName;    /* new name buffer, passed by hook (V2) */
  629. };
  630. /* NOTE: For disks CurrentSize is Sector*SectorSize, where SectorSize can
  631. be found in xadDiskInfo structure. So you may output the sector value. */
  632.  
  633. /* different progress modes */
  634. #define XADPMODE_ASK        1
  635. #define XADPMODE_PROGRESS    2
  636. #define XADPMODE_END        3
  637. #define XADPMODE_ERROR        4
  638. #define XADPMODE_NEWENTRY    5 /* (V10) */
  639. #define XADPMODE_GETINFOEND    6 /* (V11) */
  640.  
  641. /* flags for progress hook and ProgressInfo status field */
  642. #define XADPIB_OVERWRITE     0 /* overwrite the file */
  643. #define XADPIB_MAKEDIRECTORY     1 /* create the directory */
  644. #define XADPIB_IGNOREGEOMETRY     2 /* ignore drive geometry */
  645. #define XADPIB_ISDIRECTORY     3 /* destination is a directory (V10) */
  646. #define XADPIB_RENAME        10 /* rename the file (V2) */
  647. #define XADPIB_OK        16 /* all ok, proceed */
  648. #define XADPIB_SKIP        17 /* skip file */
  649.  
  650. #define XADPIF_OVERWRITE    (1<<XADPIB_OVERWRITE)
  651. #define XADPIF_MAKEDIRECTORY    (1<<XADPIB_MAKEDIRECTORY)
  652. #define XADPIF_IGNOREGEOMETRY    (1<<XADPIB_IGNOREGEOMETRY)
  653. #define XADPIF_ISDIRECTORY    (1<<XADPIB_ISDIRECTORY)
  654. #define XADPIF_RENAME        (1<<XADPIB_RENAME)
  655. #define XADPIF_OK        (1<<XADPIB_OK)
  656. #define XADPIF_SKIP        (1<<XADPIB_SKIP)
  657.  
  658. /************************************************************************
  659. *                                    *
  660. *    errors                                *
  661. *                                    *
  662. ************************************************************************/
  663.  
  664. #define XADERR_OK        0x0000 /* no error */
  665. #define XADERR_UNKNOWN        0x0001 /* unknown error */
  666. #define XADERR_INPUT        0x0002 /* input data buffers border exceeded */
  667. #define XADERR_OUTPUT        0x0003 /* output data buffers border exceeded */
  668. #define XADERR_BADPARAMS    0x0004 /* function called with illegal parameters */
  669. #define XADERR_NOMEMORY     0x0005 /* not enough memory available */
  670. #define XADERR_ILLEGALDATA    0x0006 /* data is corrupted */
  671. #define XADERR_NOTSUPPORTED    0x0007 /* command is not supported */
  672. #define XADERR_RESOURCE     0x0008 /* required resource missing */
  673. #define XADERR_DECRUNCH     0x0009 /* error on decrunching */
  674. #define XADERR_FILETYPE     0x000A /* unknown file type */
  675. #define XADERR_OPENFILE     0x000B /* opening file failed */
  676. #define XADERR_SKIP        0x000C /* file, disk has been skipped */
  677. #define XADERR_BREAK        0x000D /* user break in progress hook */
  678. #define XADERR_FILEEXISTS    0x000E /* file already exists */
  679. #define XADERR_PASSWORD     0x000F /* missing or wrong password */
  680. #define XADERR_MAKEDIR        0x0010 /* could not create directory */
  681. #define XADERR_CHECKSUM     0x0011 /* wrong checksum */
  682. #define XADERR_VERIFY        0x0012 /* verify failed (disk hook) */
  683. #define XADERR_GEOMETRY     0x0013 /* wrong drive geometry */
  684. #define XADERR_DATAFORMAT    0x0014 /* unknown data format */
  685. #define XADERR_EMPTY        0x0015 /* source contains no files */
  686. #define XADERR_FILESYSTEM    0x0016 /* unknown filesystem */
  687. #define XADERR_FILEDIR        0x0017 /* name of file exists as directory */
  688. #define XADERR_SHORTBUFFER    0x0018 /* buffer was to short */
  689. #define XADERR_ENCODING     0x0019 /* text encoding was defective */
  690.  
  691. /************************************************************************
  692. *                                    *
  693. *    characterset and filename conversion                *
  694. *                                    *
  695. ************************************************************************/
  696.  
  697. #define CHARSET_HOST              0 /* this is the ONLY destination setting for clients! */
  698.  
  699. #define CHARSET_UNICODE_UCS2_HOST      10 /* 16bit Unicode (usually no source type) */
  700. #define CHARSET_UNICODE_UCS2_BIGENDIAN      11 /* 16bit Unicode big endian storage */
  701. #define CHARSET_UNICODE_UCS2_LITTLEENDIAN 12 /* 16bit Unicode little endian storage */
  702. #define CHARSET_UNICODE_UTF8          13 /* variable size unicode encoding */
  703.  
  704. /* all the 1xx types are generic types which also maybe a bit dynamic */
  705. #define CHARSET_AMIGA            100 /* the default Amiga charset */
  706. #define CHARSET_MSDOS             101 /* the default MSDOS charset */
  707. #define CHARSET_MACOS             102 /* the default MacOS charset */
  708. #define CHARSET_C64            103 /* the default C64 charset */
  709. #define CHARSET_ATARI_ST        104 /* the default Atari ST charset */
  710. #define CHARSET_WINDOWS            105 /* the default Windows charset */
  711.  
  712. /* all the 2xx to 9xx types are real charsets, use them whenever you know
  713.    what the data really is */
  714. #define CHARSET_ASCII            200 /* the lower 7 bits of ASCII charsets */
  715. #define CHARSET_ISO_8859_1        201 /* the base charset */
  716. #define CHARSET_ISO_8859_15        215 /* Euro-sign fixed ISO variant */
  717. #define CHARSET_ATARI_ST_US        300 /* Atari ST (US) charset */
  718. #define CHARSET_PETSCII_C64_LC        301 /* C64 lower case charset */
  719. #define CHARSET_CODEPAGE_437        400 /* IBM Codepage 437 charset */
  720. #define CHARSET_CODEPAGE_1252        401 /* Windows Codepage 1252 charset */
  721.  
  722. /************************************************************************
  723. *                                    *
  724. *    client related stuff                        *
  725. *                                    *
  726. ************************************************************************/
  727.  
  728. struct xadForeman {
  729.   ULONG          xfm_Security;    /* should be XADFOREMAN_SECURITY */
  730.   ULONG          xfm_ID;          /* must be XADFOREMAN_ID */
  731.   UWORD          xfm_Version;     /* set to XADFOREMAN_VERSION */
  732.   UWORD          xfm_Reserved;
  733.   STRPTR         xfm_VersString;  /* pointer to $VER: string */
  734.   struct xadClient * xfm_FirstClient; /* pointer to first client */
  735. };
  736.  
  737. #define XADFOREMAN_SECURITY    0x70FF4E75 /* MOVEQ #-1,D0 and RTS */
  738. #define XADFOREMAN_ID        0x58414446 /* 'XADF' identification ID */
  739. #define XADFOREMAN_VERSION    1
  740.  
  741. struct xadClient {
  742.   struct xadClient * xc_Next;
  743.   UWORD          xc_Version;    /* set to XADCLIENT_VERSION */
  744.   UWORD          xc_MasterVersion;
  745.   UWORD          xc_ClientVersion;
  746.   UWORD          xc_ClientRevision;
  747.   ULONG          xc_RecogSize;  /* needed size to recog the type */
  748.   ULONG          xc_Flags;        /* see XADCF_xxx defines */
  749.   ULONG          xc_Identifier; /* ID of internal clients */
  750.   STRPTR         xc_ArchiverName;
  751.   BOOL          (* xc_RecogData)();
  752.   LONG          (* xc_GetInfo)();
  753.   LONG          (* xc_UnArchive)();
  754.   void          (* xc_Free)();
  755. };
  756.  
  757. /* function interface
  758. ASM(BOOL) xc_RecogData(REG(d0, ULONG size), REG(a0, STRPTR data),
  759.         REG(a6, struct xadMasterBase *xadMasterBase));
  760. ASM(LONG) xc_GetInfo(REG(a0, struct xadArchiveInfo *ai),
  761.         REG(a6, struct xadMasterBase *xadMasterBase));
  762. ASM(LONG) xc_UnArchive(REG(a0, struct xadArchiveInfo *ai),
  763.         REG(a6, struct xadMasterBase *xadMasterBase));
  764. ASM(void) xc_Free(REG(a0, struct xadArchiveInfo *ai),
  765.         REG(a6, struct xadMasterBase *xadMasterBase));
  766. */
  767.  
  768. /* xc_RecogData returns 1 when recognized and 0 when not, all the others
  769.    return 0 when ok and XADERR values on error. xc_Free has no return
  770.    value.
  771.  
  772.    Filesystem clients need to clear xc_RecogSize and xc_RecogData. The
  773.    recognition is automatically done by GetInfo. XADERR_FILESYSTEM is
  774.    returned in case of unknown format. If it is known detection should
  775.    go on and any other code may be returned, if it fails.
  776.    The field xc_ArchiverName means xc_FileSystemName for filesystem
  777.    clients.
  778. */
  779.  
  780. #define XADCLIENT_VERSION    1
  781.  
  782. #define XADCB_FILEARCHIVER     0 /* archiver is a file archiver */
  783. #define XADCB_DISKARCHIVER     1 /* archiver is a disk archiver */
  784. #define XADCB_EXTERN         2 /* external client, set by xadmaster */
  785. #define XADCB_FILESYSTEM     3 /* filesystem clients (V5) */
  786. #define XADCB_NOCHECKSIZE     4 /* do not check size for recog call (V6) */
  787. #define XADCB_DATACRUNCHER     5 /* file archiver is plain data file (V11) */
  788. #define XADCB_EXECRUNCHER     6 /* file archiver is executable file (V11) */
  789. #define XADCB_ADDRESSCRUNCHER     7 /* file archiver is address crunched file (V11) */
  790. #define XADCB_LINKER         8 /* file archiver is a linker file (V11) */
  791. #define XADCB_FREEXADSTRINGS    25 /* master frees XAD strings (V12) */
  792. #define XADCB_FREESPECIALINFO    26 /* master frees xadSpecial  structures (V11) */
  793. #define XADCB_FREESKIPINFO    27 /* master frees xadSkipInfo structures (V3) */
  794. #define XADCB_FREETEXTINFO    28 /* master frees xadTextInfo structures (V2) */
  795. #define XADCB_FREETEXTINFOTEXT    29 /* master frees xadTextInfo text block (V2) */
  796. #define XADCB_FREEFILEINFO    30 /* master frees xadFileInfo structures (V2) */
  797. #define XADCB_FREEDISKINFO    31 /* master frees xadDiskInfo structures (V2) */
  798.  
  799. #define XADCF_FILEARCHIVER    (1<<XADCB_FILEARCHIVER)
  800. #define XADCF_DISKARCHIVER    (1<<XADCB_DISKARCHIVER)
  801. #define XADCF_EXTERN        (1<<XADCB_EXTERN)
  802. #define XADCF_FILESYSTEM    (1<<XADCB_FILESYSTEM)
  803. #define XADCF_NOCHECKSIZE    (1<<XADCB_NOCHECKSIZE)
  804. #define XADCF_DATACRUNCHER    (1<<XADCB_DATACRUNCHER)
  805. #define XADCF_EXECRUNCHER    (1<<XADCB_EXECRUNCHER)
  806. #define XADCF_ADDRESSCRUNCHER    (1<<XADCB_ADDRESSCRUNCHER)
  807. #define XADCF_LINKER        (1<<XADCB_LINKER)
  808. #define XADCF_FREEXADSTRINGS    (1<<XADCB_FREEXADSTRINGS)
  809. #define XADCF_FREESPECIALINFO    (1<<XADCB_FREESPECIALINFO)
  810. #define XADCF_FREESKIPINFO    (1<<XADCB_FREESKIPINFO)
  811. #define XADCF_FREETEXTINFO    (1<<XADCB_FREETEXTINFO)
  812. #define XADCF_FREETEXTINFOTEXT    (1<<XADCB_FREETEXTINFOTEXT)
  813. #define XADCF_FREEFILEINFO    (1<<XADCB_FREEFILEINFO)
  814. #define XADCF_FREEDISKINFO    (1<<XADCB_FREEDISKINFO)
  815.  
  816. /* The types 5 to 9 always need XADCB_FILEARCHIVER set also. These only specify
  817. the type of the archiver somewhat better. Do not mix real archivers and these
  818. single file data clients. */
  819.  
  820. /************************************************************************
  821. *                                    *
  822. *    client ID's                            *
  823. *                                    *
  824. ************************************************************************/
  825.  
  826. /* If an external client has set the xc_Identifier field, the internal
  827. client is replaced. */
  828.  
  829. /* disk archivers start with 1000 */
  830. #define XADCID_XMASH            1000
  831. #define XADCID_SUPERDUPER3        1001
  832. #define XADCID_XDISK            1002
  833. #define XADCID_PACKDEV            1003
  834. #define XADCID_ZOOM            1004
  835. #define XADCID_ZOOM5            1005
  836. #define XADCID_CRUNCHDISK        1006
  837. #define XADCID_PACKDISK         1007
  838. #define XADCID_MDC            1008
  839. #define XADCID_COMPDISK         1009
  840. #define XADCID_LHWARP            1010
  841. #define XADCID_SAVAGECOMPRESSOR     1011
  842. #define XADCID_WARP            1012
  843. #define XADCID_GDC            1013
  844. #define XADCID_DCS            1014
  845.  
  846. /* file archivers start with 5000 */
  847. #define XADCID_TAR            5000
  848. #define XADCID_SDSSFX            5001
  849. #define XADCID_LZX            5002
  850. #define XADCID_MXMSIMPLEARC        5003
  851. #define XADCID_LHPAK            5004
  852. #define XADCID_AMIGAPLUSUNPACK        5005
  853. #define XADCID_AMIPACK            5006
  854. #define XADCID_LHA            5007
  855. #define XADCID_LHASFX            5008
  856. #define XADCID_PCOMPARC         5009
  857. #define XADCID_SOMNI            5010
  858. #define XADCID_LHSFX            5011
  859. #define XADCID_XPKARCHIVE        5012
  860. #define XADCID_SHRINK            5013
  861. #define XADCID_SPACK            5014
  862. #define XADCID_SPACKSFX         5015
  863. #define XADCID_ZIP            5016
  864. #define XADCID_WINZIPEXE        5017
  865. #define XADCID_GZIP            5018
  866. #define XADCID_ARC            5019
  867. #define XADCID_ZOO            5020
  868. #define XADCID_LHAEXE            5021
  869. #define XADCID_ARJ            5022
  870. #define XADCID_ARJEXE            5023
  871. #define XADCID_ZIPEXE            5024
  872. #define XADCID_LHF            5025
  873. #define XADCID_COMPRESS         5026
  874. #define XADCID_ACE            5027
  875. #define XADCID_ACEEXE            5028
  876. #define XADCID_GZIPSFX            5029
  877. #define XADCID_HA            5030
  878. #define XADCID_SQ            5031
  879. #define XADCID_LHAC64SFX        5032
  880. #define XADCID_SIT            5033
  881. #define XADCID_SIT5            5034
  882. #define XADCID_SIT5EXE            5035
  883. #define XADCID_MACBINARY        5036
  884. #define XADCID_CPIO            5037
  885. #define XADCID_PACKIT            5038
  886.  
  887. /* filesystem client start with 8000 */
  888.  
  889. #define XADCID_FSAMIGA            8000
  890. #define XADCID_FSSANITYOS        8001
  891. #define XADCID_FSFAT            8002
  892.  
  893. /* mixed archivers start with 9000 */
  894. #define XADCID_DMS            9000
  895. #define XADCID_DMSSFX            9001
  896.  
  897. #endif /* LIBRARIES_XADMASTER_H */
  898.